Vizbl SDK/com.us.vizbl.ar.sdk.api/VizblARController

VizblARController

interface VizblARController : ScreenCapture, QRScanner

Public API for controlling the AR experience.

Provides methods for scene manipulation, session management, and accessing current view state.

Inheritors

VizblAR

Properties

lastAddedInstanceId

abstract val lastAddedInstanceId: InstanceId?

The unique identifier of the most recently added instance, or null if no instances have been added.

placedObjects

abstract val placedObjects: List<ARPlacedObject>

The collection of all 3D objects currently placed within the AR scene.

selectedInstanceId

abstract val selectedInstanceId: InstanceId?

The unique identifier of the currently selected instance, or null if no instance is selected.

viewConfiguration

abstract val viewConfiguration: ARViewConfiguration

The current configuration for AR view layers and visual settings. Defines how the 3D content and UI overlays are rendered.

Functions

add

abstract suspend fun add(model: ARObjectReference, configuration: ARObjectConfiguration.() -> Unit = {}): InstanceId

Adds a new 3D object to the AR scene using a model reference.

capture

abstract fun capture(view: SurfaceView, fileName: String? = null, onSuccess: (Uri) -> Unit)

Captures the current frame of the specified SurfaceView and saves it to storage.

captureAndShare

abstract fun captureAndShare(view: SurfaceView, text: String? = null, onSuccess: (Uri) -> Unit)

Captures the current frame of the specified SurfaceView and launches a system share dialog.

clearCache

abstract fun clearCache()

Clears all cached resources utilized by the AR session.

dismiss

abstract fun dismiss()

Closes the AR experience and releases associated resources.

pauseSession

abstract fun pauseSession()

Pauses the current AR session, halting rendering and tracking.

remove

abstract fun remove(instanceId: InstanceId)

Removes a placed object from the scene using its instance identifier.

removeAll

abstract fun removeAll()

Removes all placed objects from the current scene.

replace

abstract suspend fun replace(instanceId: InstanceId, with: ARObjectReference, configuration: ARObjectConfiguration.() -> Unit = {}): InstanceId

Replaces an existing AR object with a new one.

resumeSession

abstract fun resumeSession()

Resumes a previously paused AR session.

startQRScanner

abstract fun startQRScanner()

Initializes and starts the QR code scanning process using the device camera.

stopCapture

abstract fun stopCapture()

Cancels any ongoing screen capture operation.